API 設計

RESTful API

一種風格規範，讓大家在與 API 互動時能夠更一致更輕鬆的規範

• 不轉址，只傳 response 給前端，由前端判斷是否轉址
• 不用動詞，只用名詞，動作由 request 中的 method 來做
• 先使用 HTTP Status Code 表達 response 狀態
• 等等

當然他只是風格規範，所以還是可以依照每個專案需求去改變，在 API 文件中交代清楚即可
API 是什麼? RESTful API 又是什麼? | Medium

Todo

因為 todo 只是簡單的會員系統、任務的 CRUD，所以使用 REST 相對容易

• 在一開始規劃時先設定每個 API 的 request、response
  • 例如：Register
    • request
      • POST ("/member/register")
      • application/json

        {
          "username": "string",
          "password": "string",
          "email": "string"
        }
        

    • response

      200
      

• 過程中稍微學習了 API Blueprint 的語法
  • 想要將相關但 route 不同的 API放一個群組
    • 使用

        ## Group
        ### Register [/member/register]
        ### Login [/member/Login]
        ### Reset [/member/reset]
        ### Member Tasks [/members/{id}/tasks]
    

  • 需要網址參數時：
    • 使用

      ### Member Tasks [/members/{id}/tasks]
       + Parameters
           + id: `1` (integer, required) - ID of the member
      

• 最後用 Apiary 建立一份文件
  • 當然過程中有請 ChatGPT 幫忙把原本的規格快速改成 API Blueprint 的格式

REST API 文件

API 文件